Skip to content

Adds SDK setup link #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
franrob-projects merged 1 commit into from
Sep 1, 2025
Merged

Adds SDK setup link #619

franrob-projects merged 1 commit into from
Sep 1, 2025

Conversation

@franrob-projects
Copy link
Contributor

@franrob-projects franrob-projects commented Aug 28, 2025 •
edited by coderabbitai bot
Loading

This PR:

  • Adds "SDK setup link" for consistency with other readmes

Summary by CodeRabbit

  • Documentation
    • Added a new “SDK Setup for Python” link under the Getting started section, placed after the existing Pub/Sub with Python guide to direct users to setup instructions.
    • Improves onboarding clarity for Python developers by separating environment setup from the Pub/Sub tutorial.
    • Enhances discoverability of Python setup resources.
    • No code, API, or runtime behavior changes, and no modifications to exported or public interfaces.

@coderabbitai
Copy link

coderabbitai bot commented Aug 28, 2025 •
edited
Loading

Walkthrough

A single documentation change adds a new “SDK Setup for Python” link under the README’s “Getting started” section, placed after the existing Python Pub/Sub link. No code or API changes.

Changes

Cohort / File(s) Summary
Docs
README.md		 Added a new bullet linking to “SDK Setup for Python” (https://ably.com/docs/getting-started/setup?lang=python) under “Getting started”.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibbled the docs with a gentle hop,
Placed a link—plip plop, non-stop!
Python paths now quick to see,
A breadcrumb trail for devs like me.
Thump-thump—ship it, whee! 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Adds-sdk-setup

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Aug 28, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

24-24: Good addition; align link text casing with surrounding style.

The adjacent bullet uses sentence case; consider "SDK setup for Python." for consistency.

Apply:

-* [SDK Setup for Python.](https://ably.com/docs/getting-started/setup?lang=python)
+* [SDK setup for Python.](https://ably.com/docs/getting-started/setup?lang=python)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 5007cb6 and 317206f.

📒 Files selected for processing (1)
  • README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
  • GitHub Check: check (3.10)
  • GitHub Check: check (3.9)
  • GitHub Check: check (3.13)
  • GitHub Check: check (3.11)
  • GitHub Check: check (3.8)
  • GitHub Check: check (3.12)
  • GitHub Check: check (3.7)
🔇 Additional comments (2)
README.md (2)

23-24: All links return HTTP 200; ready to merge.

36-36: Align minimum Python requirement

Change the install instruction on line 55 to “Python 3.7 or greater” to match the CI test matrix (3.7–3.13):

- Install [Python](https://www.python.org/downloads/) version 3.8 or greater.
+ Install [Python](https://www.python.org/downloads/) version 3.7 or greater.

@franrob-projects franrob-projects merged commit 07d11a2 into main Sep 1, 2025
3 of 10 checks passed
@franrob-projects franrob-projects deleted the Adds-sdk-setup branch September 1, 2025 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@ttypic ttypic ttypic approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@franrob-projects @ttypic